Kanzi 4.0.0-beta2
kanzi::gfx::ClearCommand Struct Reference

Clears viewport. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::ClearCommand:
[legend]

Public Member Functions

 ClearCommand ()
 Constructor.
 
- Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t getSize () const
 Gets the command size in bytes.
 
uint8_t getTag () const
 Gets the command tag.
 
CommandType getType () const
 Gets the command type.
 
void setTag (uint8_t tag)
 Sets the command tag.
 

Public Attributes

array< optional< ColorClearValue >, limits::MaxColorAttachmentsclearColors
 An array of clear colors to use for each attachment.
 
optional< floatclearDepth
 An optional depth clear value.
 
optional< uint32_tclearStencil
 An optional depth stencil clear value.
 

Additional Inherited Members

- Protected Member Functions inherited from kanzi::gfx::BaseCommand
 BaseCommand (CommandType t, uint32_t s)
 Constructor.
 
 BaseCommand (const BaseCommand &other)
 Copy Constructor.
 
BaseCommandoperator= (const BaseCommand &other)
 Assignment operator.
 

Detailed Description

Clears viewport.

Since
Kanzi 4.0.0

Constructor & Destructor Documentation

◆ ClearCommand()

kanzi::gfx::ClearCommand::ClearCommand ( )
inlineexplicit

Constructor.

Member Data Documentation

◆ clearColors

array<optional<ColorClearValue>, limits::MaxColorAttachments> kanzi::gfx::ClearCommand::clearColors

An array of clear colors to use for each attachment.

◆ clearDepth

optional<float> kanzi::gfx::ClearCommand::clearDepth

An optional depth clear value.

◆ clearStencil

optional<uint32_t> kanzi::gfx::ClearCommand::clearStencil

An optional depth stencil clear value.


The documentation for this struct was generated from the following file: